2.x composite disposable docs #6432
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…m in vararg param is null
…aming at methods, added @throws javadoc where applicable
akarnokd
requested changes
Mar 15, 2019
| for (Disposable d : resources) { | ||
| ObjectHelper.requireNonNull(d, "Disposable item is null"); | ||
| public CompositeDisposable(@NonNull Disposable... disposables) { | ||
| ObjectHelper.requireNonNull(disposables, "Disposables are null"); |
There was a problem hiding this comment.
Please use lowercase as it refers to the argument: disposables is null.
| ObjectHelper.requireNonNull(disposables, "Disposables are null"); | ||
| this.resources = new OpenHashSet<Disposable>(disposables.length + 1); | ||
| for (Disposable d : disposables) { | ||
| ObjectHelper.requireNonNull(d, "Disposable item in Disposables is null"); |
There was a problem hiding this comment.
Again, lowercase: A Disposable in the disposables array is null.
| public CompositeDisposable(@NonNull Iterable<? extends Disposable> resources) { | ||
| ObjectHelper.requireNonNull(resources, "resources is null"); | ||
| public CompositeDisposable(@NonNull Iterable<? extends Disposable> disposables) { | ||
| ObjectHelper.requireNonNull(disposables, "Disposables are null"); |
| @@ -38,26 +38,28 @@ public CompositeDisposable() { | |||
|
|
|||
| /** | |||
| * Creates a CompositeDisposables with the given array of initial elements. | |||
| * @param resources the array of Disposables to start with | |||
| * @param disposables the array of Disposables to start with | |||
| * @throws NullPointerException if disposables param is null, or a Disposable item in the disposables is null | |||
There was a problem hiding this comment.
if {@code disposables} or any of its array items is null
| this.resources.add(d); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Creates a CompositeDisposables with the given Iterable sequence of initial elements. | ||
| * @param resources the Iterable sequence of Disposables to start with | ||
| * @param disposables the Iterable sequence of Disposables to start with | ||
| * @throws NullPointerException if disposables param is null, or a Disposable item in the disposables is null |
There was a problem hiding this comment.
if {@code disposables} or any of its returned items is null
| * @return true if the operation was successful, false if the container has been disposed | ||
| * @throws NullPointerException if disposables param is null, or a Disposable item in the disposables is null |
There was a problem hiding this comment.
if {@code disposables} or any of its array items is null
| public boolean addAll(@NonNull Disposable... ds) { | ||
| ObjectHelper.requireNonNull(ds, "ds is null"); | ||
| public boolean addAll(@NonNull Disposable... disposables) { | ||
| ObjectHelper.requireNonNull(disposables, "Disposables are null"); |
| for (Disposable d : ds) { | ||
| ObjectHelper.requireNonNull(d, "d is null"); | ||
| for (Disposable d : disposables) { | ||
| ObjectHelper.requireNonNull(d, "Disposable item in Disposables is null"); |
There was a problem hiding this comment.
A Disposable in the disposables array is null
| * @return true if the operation was successful | ||
| * @throws NullPointerException if disposable param is null |
| public boolean delete(@NonNull Disposable d) { | ||
| ObjectHelper.requireNonNull(d, "Disposable item is null"); | ||
| public boolean delete(@NonNull Disposable disposable) { | ||
| ObjectHelper.requireNonNull(disposable, "Disposable item is null"); |
Codecov Report
@@ Coverage Diff @@
## 2.x #6432 +/- ##
============================================
- Coverage 98.34% 98.27% -0.07%
+ Complexity 6300 6299 -1
============================================
Files 675 675
Lines 45172 45172
Branches 6246 6246
============================================
- Hits 44425 44394 -31
- Misses 229 244 +15
- Partials 518 534 +16
Continue to review full report at Codecov.
|
|
Thanks for your feedback, I think I addressed all of your suggestions. |
akarnokd
approved these changes
Mar 15, 2019
vanniktech
approved these changes
Mar 15, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On CompositeDisposable add and addAll methods, if the param is null, currently the NPE error message (produced by ObjectHelper) is "d is null" which is not very helpful.
This is a small refactor for making the message a bit more helpful.
Resolves #6430